Expose ACP versions of the base/script/user paths #76
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The standard encoding for all the top level paths (base, script, user) in SimpleGraphic is UTF-8. For some purposes it's useful to know if the path can be expressed in the user's active codepage as well, the updater can use it to form absolute paths that the OS understands. As the user path is fallible, we also expose a human-readable reason as to why it could not be obtained. All paths are made weakly canonical rather than fully canonical as the full flavour requires paths to fully exist.
Whenever an invalid code unit was detected, a placeholder should be emitted. This change fixes a bug where it also wrote out the original code unit as-is.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes the three path query functions also expose an ACP encoding of the path if possible. The user path query can now also return a human-readable reason when it can't be obtained from the OS.
This is useful for scripts as they can now tell if paths can be expressed in the user's codepage.
This enables an use case in the update preparation logic where it can form absolute paths if the path is entirely within the ACP. When relative paths were in use there to work around that the path could be unspellable, the wrong directory could be operated on thanks to filesystem virtualisation.